Add DocTests to is_palindrome.py #10081
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
October 8, 2023 13:02
algorithms-keeper
bot
added
enhancement
for more information, see https://pre-commit.ci
…om/SaiHarshaK/Python into u/skottapalli/is_palindrome_update
cclauss
requested changes
Oct 8, 2023
Comment on lines
+134
to
+136
| >>> is_palindrome_dict(\ | ||
| ListNode(\ | ||
| 1, ListNode(2, ListNode(1, ListNode(3, ListNode(2, ListNode(1))))))) |
There was a problem hiding this comment.
PEP8 discourages backslash line termination in Python because any whitespace to the right of the backslash breaks the script on a change that is invisible to the reader. Also, backslashes are not required inside of (), [], {}...
Suggested change
| >>> is_palindrome_dict(\ | |
| ListNode(\ | |
| 1, ListNode(2, ListNode(1, ListNode(3, ListNode(2, ListNode(1))))))) | |
| >>> is_palindrome_dict( | |
| ... ListNode( | |
| ... 1, ListNode(2, ListNode(1, ListNode(3, ListNode(2, ListNode(1))))) | |
| ... ) | |
| ... ) |
There was a problem hiding this comment.
Ruff complains that the length of the line is >88 which is why I had to split them into multiple lines.
If i do not add backslash, DocTest assumes ListNode( is the expected value and thereby the test fails
There was a problem hiding this comment.
You needed the three dots at the beginning of each continued line as discussed in the doctest docs.
algorithms-keeper
bot
added
awaiting changes
Co-authored-by: Christian Clauss <[email protected]>
algorithms-keeper
bot
added
awaiting reviews
cclauss
reviewed
Oct 8, 2023
|
@cclauss Please check now |
cclauss
reviewed
Oct 8, 2023
|
Could you check the comment regarding backslashes? |
cclauss
approved these changes
Oct 9, 2023
algorithms-keeper
bot
removed
the
awaiting reviews
|
I changed the title from doctests to type hints but this looks good to go... Thanks. |
cclauss
added a commit
that referenced
this pull request
Oct 9, 2023
14 tasks
cclauss
added a commit
that referenced
this pull request
Oct 9, 2023
sedatguzelsemme
pushed a commit
to sedatguzelsemme/Python
that referenced
this pull request
Sep 15, 2024
* add doctest ut * test complete * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * format * ruff update * cover line 154 * Update data_structures/linked_list/is_palindrome.py Co-authored-by: Christian Clauss <[email protected]> * use dataclass * pre-commit fix * Fix mypy errors * use future annotations --------- Co-authored-by: Harsha Kottapalli <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Christian Clauss <[email protected]>
sedatguzelsemme
pushed a commit
to sedatguzelsemme/Python
that referenced
this pull request
Sep 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your change:
This PR adds DocTests to the functions in is_palindrome.py to increase its codecoverage from 0% to 96%.
Tested this change locally and can verify that they are passing.
Ref #9943
Checklist: